/*
 * Encog(tm) Core v3.4 - Java Version
 * http://www.heatonresearch.com/encog/
 * https://github.com/encog/encog-java-core
 
 * Copyright 2008-2017 Heaton Research, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *   
 * For more information on Heaton Research copyrights, licenses 
 * and trademarks visit:
 * http://www.heatonresearch.com/copyright
 */
package org.encog.neural.networks.training;

/**
 * The batch size. Specify 1 for pure online training. Specify 0 for pure batch
 * training (complete training set in one batch). Otherwise specify the batch
 * size for batch training.
 */
public interface BatchSize {
	/**
	 * The batch size. Specify 1 for pure online training. Specify 0 for pure
	 * batch training (complete training set in one batch). Otherwise specify
	 * the batch size for batch training.
	 * 
	 * @return The batch size.
	 */
	int getBatchSize();

	/**
	 * Set the batch size. Specify 1 for pure online training. Specify 0 for
	 * pure batch training (complete training set in one batch). Otherwise
	 * specify the batch size for batch training.
	 * 
	 * @param theBatchSize The batch size.
	 */
	void setBatchSize(int theBatchSize);
}
